If no path is found or when using the -ScriptDefinition parameter set, default to the current location for the directory search of the implicit settings file #979
Conversation
…, default to the current location for the directory search of the implicit settings file
bergmeister
changed the title
| $violations = Invoke-ScriptAnalyzer -Path $project1Root -Recurse | ||
| $violations.Count | Should -Be 1 | ||
| $violations[0].RuleName | Should -Be "PSAvoidUsingCmdletAliases" | ||
| } | ||
|
|
||
| It "runs rules from the implicit setting file using the -ScriptDefinition parameter set" { | ||
| Push-Location $project1Root |
There was a problem hiding this comment.
Can you, please, explain what is happening in here? Why are we pushing the $project1Root?
There was a problem hiding this comment.
Similar to the test above I am testing that PSSA implicitly picks up the settings file (see feature description here). PSSA goes through various search paths like e.g. the supplied path (test above) or current working directory (this test/PR) or even the Desktop.
| $violations = Invoke-ScriptAnalyzer -ScriptDefinition 'gci; Write-Host' -Recurse | ||
| Pop-Location | ||
| $violations.Count | Should -Be 1 | ||
| $violations[0].RuleName | Should -Be "PSAvoidUsingCmdletAliases" ` |
There was a problem hiding this comment.
Maybe Should -BeExactly, I think it should match the case as well.
There was a problem hiding this comment.
Yes, we could use exact matching but I will need to apply that to surrounding test cases for consistency. I was wondering for a while if we should try to come up with a best practice example test template that we either document or even make a test helper method for it since nearly all PSSA tests are kind of the same...
PR Summary
Fixes #978. This allows usage of the implicit settings file when using the
-ScriptDefinitionparameter (or avoid a misleading error message about setting parsing when no file is found to be analysed). When no file path was found using the-Pathoption or using the-ScriptDefinitionparameter set, the search for implicit setting files used to rely on a path being present. This PR fixes it to fallback to the current working directory as a search directory for implicit setting file.PR Checklist
Note: Tick the boxes below that apply to this pull request by putting an
xbetween the square brackets. Please mark anything not applicable to this PRNA.WIP:to the beginning of the title and remove the prefix when the PR is ready